changelog: parse release-drafter notes with - bullets and ## headers#3536
Conversation
ReleaseNoteParser only matched `*` bullets and `###` section headers, so it failed on release-drafter output that uses `-` bullets (GitHub-style `- <title> by @<author> in #<n>`) and level-2 (`##`) emoji headers. This is the default release-drafter shape and what docs-builder itself emits, so `changelog gh-release` detected the format as Unknown, extracted zero PRs, and produced empty bundles. Accept both `*`/`-` bullets and section headers at level 2 or deeper, and detect the release-drafter format on `##` headers. Adds ReleaseNoteParser unit tests for the docs-builder format plus regressions for the legacy (`###`/`*`) and GitHub-default shapes. Co-authored-by: Cursor <cursoragent@cursor.com>
|
Warning Review limit reached
More reviews will be available in 58 minutes and 36 seconds. Learn how PR review limits work. Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file). ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits. 🚦 How do rate limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate. For paid Pro and Pro+ PR reviews, CodeRabbit uses rolling per-developer review limits. Reviews become available again as older review attempts age out of the rolling limit window. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (4)
✨ Finishing Touches✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Add docs/changelog.yml (generated via `changelog init`, then mapped to the repository's established release-drafter labels) and a changelog-publish.yml workflow that turns each published GitHub release into a CDN-hosted bundle via `changelog gh-release`. workflow_dispatch allows backfilling past release tags. Co-authored-by: Cursor <cursoragent@cursor.com>
Why
changelog gh-releasederives changelog entries from a GitHub release's body, butReleaseNoteParseronly recognized:*bullets (asterisk), and###section headers.That doesn't match the default release-drafter output — nor what docs-builder itself emits — which uses
-bullets (- <title> by @<author> in #<n>) and level-2 (##) emoji headers. As a result the format was detected asUnknown, zero PR references were extracted, and the produced bundle was empty.Found while dogfooding the changelog CDN flow on docs-builder's own
1.18.1release:What
PrLineRegex: accept both*and-bullets (^[*-]\s+…).SectionHeaderRegex: accept headers at level 2 or deeper (^#{2,}\s+…).HasEmojiSectionHeaders): trigger on##rather than requiring###.ReleaseNoteParserTestscovering the docs-builder format, plus regressions for the legacy (###/*) and GitHub-default shapes.After the fix, the same release parses as:
Test plan
dotnet test tests/Elastic.Changelog.Tests(746 passed, incl. 6 new)./build.sh build --skip-dirty-check(lint + compile clean)changelog gh-release docs-builder 1.18.1now detects ReleaseDrafter + 3 PRsMade with Cursor